home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 3.iso / dist / fw_texinfo.idb / usr / freeware / info / info.info.z / info.info
Text File  |  2001-07-06  |  34KB  |  839 lines
  1. This is info.info, produced by makeinfo version 4.0 from info.texi.
  2.  
  3. INFO-DIR-SECTION Texinfo documentation system
  4. START-INFO-DIR-ENTRY
  5. * Info: (info).                 Documentation browsing system.
  6. END-INFO-DIR-ENTRY
  7.  
  8.    This file describes how to use Info, the on-line, menu-driven GNU
  9. documentation system.
  10.  
  11.    Copyright (C) 1989, 92, 96, 97, 98, 99 Free Software Foundation, Inc.
  12.  
  13.    Permission is granted to make and distribute verbatim copies of this
  14. manual provided the copyright notice and this permission notice are
  15. preserved on all copies.
  16.  
  17.    Permission is granted to copy and distribute modified versions of
  18. this manual under the conditions for verbatim copying, provided that
  19. the entire resulting derived work is distributed under the terms of a
  20. permission notice identical to this one.
  21.  
  22.    Permission is granted to copy and distribute translations of this
  23. manual into another language, under the above conditions for modified
  24. versions, except that this permission notice may be stated in a
  25. translation approved by the Free Software Foundation.
  26.  
  27. 
  28. File: info.info,  Node: Top,  Next: Getting Started,  Up: (dir)
  29.  
  30. Info: An Introduction
  31. *********************
  32.  
  33.    Info is a program for reading documentation, which you are using now.
  34.  
  35.    To learn how to use Info, type the command `h'.  It brings you to a
  36. programmed instruction sequence.
  37.  
  38. * Menu:
  39.  
  40. * Getting Started::             Getting started using an Info reader.
  41. * Advanced Info::               Advanced commands within Info.
  42. * Creating an Info File::       How to make your own Info file.
  43.  
  44. 
  45. File: info.info,  Node: Getting Started,  Next: Advanced Info,  Prev: Top,  Up: Top
  46.  
  47. Getting Started
  48. ***************
  49.  
  50.    This first part of the Info manual describes how to get around inside
  51. of Info.  The second part of the manual describes various advanced Info
  52. commands, and how to write an Info as distinct from a Texinfo file.
  53. The third part is about how to generate Info files from Texinfo files.
  54.  
  55. * Menu:
  56.  
  57. * Help-Small-Screen::   Starting Info on a Small Screen
  58. * Help::                How to use Info
  59. * Help-P::              Returning to the Previous node
  60. * Help-^L::             The Space, Rubout, B and ^L commands.
  61. * Help-M::              Menus
  62. * Help-Adv::            Some advanced Info commands
  63. * Help-Q::              Quitting Info
  64.  
  65. 
  66. File: info.info,  Node: Help-Small-Screen,  Next: Help,  Up: Getting Started
  67.  
  68. Starting Info on a Small Screen
  69. ===============================
  70.  
  71.    Since your terminal has an unusually small number of lines on its
  72. screen, it is necessary to give you special advice at the beginning.
  73.  
  74.    If you see the text `--All----' at near the bottom right corner of
  75. the screen, it means the entire text you are looking at fits on the
  76. screen.  If you see `--Top----' instead, it means that there is more
  77. text below that does not fit.  To move forward through the text and see
  78. another screen full, press the Space bar, <SPC>.  To move back up,
  79. press the key labeled `Backspace' or <Delete>.
  80.  
  81.    Here are 40 lines of junk, so you can try Spaces and Deletes and see
  82. what they do.  At the end are instructions of what you should do next.
  83.  
  84.    This is line 17
  85. This is line 18
  86. This is line 19
  87. This is line 20
  88. This is line 21
  89. This is line 22
  90. This is line 23
  91. This is line 24
  92. This is line 25
  93. This is line 26
  94. This is line 27
  95. This is line 28
  96. This is line 29
  97. This is line 30
  98. This is line 31
  99. This is line 32
  100. This is line 33
  101. This is line 34
  102. This is line 35
  103. This is line 36
  104. This is line 37
  105. This is line 38
  106. This is line 39
  107. This is line 40
  108. This is line 41
  109. This is line 42
  110. This is line 43
  111. This is line 44
  112. This is line 45
  113. This is line 46
  114. This is line 47
  115. This is line 48
  116. This is line 49
  117. This is line 50
  118. This is line 51
  119. This is line 52
  120. This is line 53
  121. This is line 54
  122. This is line 55
  123. This is line 56
  124. If you have managed to get here, go back to the beginning with Delete,
  125. and come back here again, then you understand Space and Delete.  So now
  126. type an `n' --just one character; don't type the quotes and don't type
  127. the Return key afterward-- to get to the normal start of the course.
  128.  
  129. 
  130. File: info.info,  Node: Help,  Next: Help-P,  Prev: Help-Small-Screen,  Up: Getting Started
  131.  
  132. How to use Info
  133. ===============
  134.  
  135.    You are talking to the program Info, for reading documentation.
  136.  
  137.    Right now you are looking at one "Node" of Information.  A node
  138. contains text describing a specific topic at a specific level of
  139. detail.  This node's topic is "how to use Info".
  140.  
  141.    The top line of a node is its "header".  This node's header (look at
  142. it now) says that it is the node named `Help' in the file `info'.  It
  143. says that the `Next' node after this one is the node called `Help-P'.
  144. An advanced Info command lets you go to any node whose name you know.
  145.  
  146.    Besides a `Next', a node can have a `Previous' or an `Up'.  This
  147. node has a `Previous' but no `Up', as you can see.
  148.  
  149.    Now it is time to move on to the `Next' node, named `Help-P'.
  150.  
  151.    >> Type `n' to move there.  Type just one character;    do not type
  152. the quotes and do not type a <RET> afterward.
  153.  
  154.    `>>' in the margin means it is really time to try a command.
  155.  
  156. 
  157. File: info.info,  Node: Help-P,  Next: Help-^L,  Prev: Help,  Up: Getting Started
  158.  
  159. Returning to the Previous node
  160. ==============================
  161.  
  162.    This node is called `Help-P'.  The `Previous' node, as you see, is
  163. `Help', which is the one you just came from using the `n' command.
  164. Another `n' command now would take you to the next node, `Help-^L'.
  165.  
  166.    >> But do not do that yet.  First, try the `p' command, which takes
  167.  you to the `Previous' node.  When you get there, you can do an    `n'
  168. again to return here.
  169.  
  170.    This all probably seems insultingly simple so far, but _do not_ be
  171. led into skimming.  Things will get more complicated soon.  Also, do
  172. not try a new command until you are told it is time to.  Otherwise, you
  173. may make Info skip past an important warning that was coming up.
  174.  
  175.    >> Now do an `n' to get to the node `Help-^L' and learn more.
  176.  
  177. 
  178. File: info.info,  Node: Help-^L,  Next: Help-M,  Prev: Help-P,  Up: Getting Started
  179.  
  180. The Space, Delete, B and ^L commands.
  181. =====================================
  182.  
  183.    This node's header tells you that you are now at node `Help-^L', and
  184. that `p' would get you back to `Help-P'.  The node's title is
  185. underlined; it says what the node is about (most nodes have titles).
  186.  
  187.    This is a big node and it does not all fit on your display screen.
  188. You can tell that there is more that is not visible because you can see
  189. the string `--Top-----' rather than `--All----' near the bottom right
  190. corner of the screen.
  191.  
  192.    The Space, Delete and `B' commands exist to allow you to "move
  193. around" in a node that does not all fit on the screen at once.  Space
  194. moves forward, to show what was below the bottom of the screen.  Delete
  195. moves backward, to show what was above the top of the screen (there is
  196. not anything above the top until you have typed some spaces).
  197.  
  198.    >> Now try typing a Space (afterward, type a Delete to return here).
  199.  
  200.    When you type the space, the two lines that were at the bottom of
  201. the screen appear at the top, followed by more lines.  Delete takes the
  202. two lines from the top and moves them to the bottom, _usually_, but if
  203. there are not a full screen's worth of lines above them they may not
  204. make it all the way to the bottom.
  205.  
  206.    If you type Space when there is no more to see, it rings the bell
  207. and otherwise does nothing.  The same goes for Delete when the header
  208. of the node is visible.
  209.  
  210.    If your screen is ever garbaged, you can tell Info to print it out
  211. again by typing `C-l' (`Control-L', that is--hold down "Control" and
  212. type an <L> or `l').
  213.  
  214.    >> Type `C-l' now.
  215.  
  216.    To move back to the beginning of the node you are on, you can type a
  217. lot of Deletes.  You can also type simply `b' for beginning.  >> Try
  218. that now.  (We have put in enough verbiage to push this past the first
  219. screenful, but screens are so big nowadays that perhaps it isn't
  220. enough.  You may need to shrink your Emacs or Info window.)  Then come
  221. back, with Spaces.
  222.  
  223.    If your screen is very tall, all of this node might fit at once.  In
  224. that case, "b" won't do anything.  Sorry; what can we do?
  225.  
  226.    You have just learned a considerable number of commands.  If you
  227. want to use one but have trouble remembering which, you should type a
  228. <?> which prints out a brief list of commands.  When you are finished
  229. looking at the list, make it go away by pressing <SPC> repeatedly.
  230.  
  231.    >> Type a <?> now.  Press <SPC> to see consecutive screenfuls of >>
  232. the list until finished.
  233.  
  234.    From now on, you will encounter large nodes without warning, and
  235. will be expected to know how to use Space and Delete to move around in
  236. them without being told.  Since not all terminals have the same size
  237. screen, it would be impossible to warn you anyway.
  238.  
  239.    >> Now type `n' to see the description of the `m' command.
  240.  
  241. 
  242. File: info.info,  Node: Help-M,  Next: Help-Adv,  Prev: Help-^L,  Up: Getting Started
  243.  
  244. Menus
  245. =====
  246.  
  247.    Menus and the `m' command
  248.  
  249.    With only the `n' and `p' commands for moving between nodes, nodes
  250. are restricted to a linear sequence.  Menus allow a branching
  251. structure.  A menu is a list of other nodes you can move to.  It is
  252. actually just part of the text of the node formatted specially so that
  253. Info can interpret it.  The beginning of a menu is always identified by
  254. a line which starts with `* Menu:'.  A node contains a menu if and only
  255. if it has a line in it which starts that way.  The only menu you can
  256. use at any moment is the one in the node you are in.  To use a menu in
  257. any other node, you must move to that node first.
  258.  
  259.    After the start of the menu, each line that starts with a `*'
  260. identifies one subtopic.  The line usually contains a brief name for
  261. the subtopic (followed by a `:'), the name of the node that talks about
  262. that subtopic, and optionally some further description of the subtopic.
  263. Lines in the menu that do not start with a `*' have no special
  264. meaning--they are only for the human reader's benefit and do not define
  265. additional subtopics.  Here is an example:
  266.  
  267.      * Foo:  FOO's Node      This tells about FOO
  268.  
  269.    The subtopic name is Foo, and the node describing it is `FOO's Node'.
  270. The rest of the line is just for the reader's Information.  [[ But this
  271. line is not a real menu item, simply because there is no line above it
  272. which starts with `* Menu:'.]]
  273.  
  274.    When you use a menu to go to another node (in a way that will be
  275. described soon), what you specify is the subtopic name, the first thing
  276. in the menu line.  Info uses it to find the menu line, extracts the
  277. node name from it, and goes to that node.  The reason that there is
  278. both a subtopic name and a node name is that the node name must be
  279. meaningful to the computer and may therefore have to be ugly looking.
  280. The subtopic name can be chosen just to be convenient for the user to
  281. specify.  Often the node name is convenient for the user to specify and
  282. so both it and the subtopic name are the same.  There is an
  283. abbreviation for this:
  284.  
  285.      * Foo::   This tells about FOO
  286.  
  287. This means that the subtopic name and node name are the same; they are
  288. both `Foo'.
  289.  
  290.    >> Now use Spaces to find the menu in this node, then come back to
  291. the front with a `b' and some Spaces.  As you see, a menu is
  292. actually visible in its node.  If you cannot find a menu in a node
  293. by looking at it, then the node does not have a menu and the    `m'
  294. command is not available.
  295.  
  296.    The command to go to one of the subnodes is `m'--but _do not do it
  297. yet!_  Before you use `m', you must understand the difference between
  298. commands and arguments.  So far, you have learned several commands that
  299. do not need arguments.  When you type one, Info processes it and is
  300. instantly ready for another command.  The `m' command is different: it
  301. is incomplete without the "name of the subtopic".  Once you have typed
  302. `m', Info tries to read the subtopic name.
  303.  
  304.    Now look for the line containing many dashes near the bottom of the
  305. screen.  There is one more line beneath that one, but usually it is
  306. blank.  If it is empty, Info is ready for a command, such as `n' or `b'
  307. or Space or `m'.  If that line contains text ending in a colon, it mean
  308. Info is trying to read the "argument" to a command.  At such times,
  309. commands do not work, because Info tries to use them as the argument.
  310. You must either type the argument and finish the command you started,
  311. or type `Control-g' to cancel the command.  When you have done one of
  312. those things, the line becomes blank again.
  313.  
  314.    The command to go to a subnode via a menu is `m'.  After you type
  315. the `m', the line at the bottom of the screen says `Menu item: '.  You
  316. must then type the name of the subtopic you want, and end it with a
  317. <RET>.
  318.  
  319.    You can abbreviate the subtopic name.  If the abbreviation is not
  320. unique, the first matching subtopic is chosen.  Some menus put the
  321. shortest possible abbreviation for each subtopic name in capital
  322. letters, so you can see how much you need to type.  It does not matter
  323. whether you use upper case or lower case when you type the subtopic.
  324. You should not put any spaces at the end, or inside of the item name,
  325. except for one space where a space appears in the item in the menu.
  326.  
  327.    You can also use the "completion" feature to help enter the subtopic
  328. name.  If you type the Tab key after entering part of a name, it will
  329. magically fill in more of the name--as much as follows uniquely from
  330. what you have entered.
  331.  
  332.    If you move the cursor to one of the menu subtopic lines, then you do
  333. not need to type the argument: you just type a Return, and it stands for
  334. the subtopic of the line you are on.
  335.  
  336.    Here is a menu to give you a chance to practice.  This menu gives you
  337. three ways of going to one place, Help-FOO:
  338.  
  339. * Menu:
  340.  
  341. * Foo:  Help-FOO.       A node you can visit for fun.
  342. * Bar:  Help-FOO.       Strange!  two ways to get to the same place.
  343. * Help-FOO::            And yet another!
  344.  
  345.    >>  Now type just an `m' and see what happens:
  346.  
  347.    Now you are "inside" an `m' command.  Commands cannot be used now;
  348. the next thing you will type must be the name of a subtopic.
  349.  
  350.    You can change your mind about doing the `m' by typing Control-g.
  351.  
  352.    >> Try that now;  notice the bottom line clear.
  353.  
  354.    >> Then type another `m'.
  355.  
  356.    >> Now type `BAR' item name.  Do not type Return yet.
  357.  
  358.    While you are typing the item name, you can use the Delete key to
  359. cancel one character at a time if you make a mistake.
  360.  
  361.    >> Type one to cancel the `R'.  You could type another `R' to
  362. replace it.  You do not have to, since `BA' is a valid abbreviation.
  363.  
  364.    >> Now you are ready to go.  Type a <RET>.
  365.  
  366.    After visiting Help-FOO, you should return here.
  367.  
  368.    >> Type `n' to see more commands.
  369.  
  370.    Here is another way to get to  Help-FOO, a menu.  You can ignore this
  371. if you want, or else try it (but then please come back to here).
  372.  
  373. * Menu:
  374.  
  375. * Help-FOO::
  376.  
  377. 
  378. File: info.info,  Node: Help-FOO,  Up: Help-M
  379.  
  380. The `u' command
  381. ---------------
  382.  
  383.    Congratulations!  This is the node `Help-FOO'.  Unlike the other
  384. nodes you have seen, this one has an `Up': `Help-M', the node you just
  385. came from via the `m' command.  This is the usual convention--the nodes
  386. you reach from a menu have `Up' nodes that lead back to the menu.
  387. Menus move Down in the tree, and `Up' moves Up.  `Previous', on the
  388. other hand, is usually used to "stay on the same level but go backwards"
  389.  
  390.    You can go back to the node `Help-M' by typing the command `u' for
  391. "Up".  That puts you at the _front_ of the node--to get back to where
  392. you were reading you have to type some <SPC>s.
  393.  
  394.    >> Now type `u' to move back up to `Help-M'.
  395.  
  396. 
  397. File: info.info,  Node: Help-Adv,  Next: Help-Q,  Prev: Help-M,  Up: Getting Started
  398.  
  399. Some advanced Info commands
  400. ===========================
  401.  
  402.    The course is almost over, so please stick with it to the end.
  403.  
  404.    If you have been moving around to different nodes and wish to
  405. retrace your steps, the `l' command (`l' for "last") will do that, one
  406. node-step at a time.  As you move from node to node, Info records the
  407. nodes where you have been in a special history list.  The `l' command
  408. revisits nodes in the history list; each successive `l' command moves
  409. one step back through the history.
  410.  
  411.    If you have been following directions, ad `l' command now will get
  412. you back to `Help-M'.  Another `l' command would undo the `u' and get
  413. you back to `Help-FOO'.  Another `l' would undo the `m' and get you
  414. back to `Help-M'.
  415.  
  416.    >> Try typing three `l''s, pausing in between to see what each
  417. `l' does.
  418.  
  419.    Then follow directions again and you will end up back here.
  420.  
  421.    Note the difference between `l' and `p': `l' moves to where _you_
  422. last were, whereas `p' always moves to the node which the header says
  423. is the `Previous' node (from this node, to `Help-M').
  424.  
  425.    The `d' command gets you instantly to the Directory node.  This
  426. node, which is the first one you saw when you entered Info, has a menu
  427. which leads (directly, or indirectly through other menus), to all the
  428. nodes that exist.
  429.  
  430.    >> Try doing a `d', then do an `l' to return here (yes,    _do_
  431. return).
  432.  
  433.    Sometimes, in Info documentation, you will see a cross reference.
  434. Cross references look like this: *Note Cross: Help-Cross.  That is a
  435. real, live cross reference which is named `Cross' and points at the
  436. node named `Help-Cross'.
  437.  
  438.    If you wish to follow a cross reference, you must use the `f'
  439. command.  The `f' must be followed by the cross reference name (in this
  440. case, `Cross').  While you enter the name, you can use the Delete key
  441. to edit your input.  If you change your mind about following any
  442. reference, you can use `Control-g' to cancel the command.
  443.  
  444.    Completion is available in the `f' command; you can complete among
  445. all the cross reference names in the current node by typing a Tab.
  446.  
  447.    >> Type `f', followed by `Cross', and a <RET>.
  448.  
  449.    To get a list of all the cross references in the current node, you
  450. can type `?' after an `f'.  The `f' continues to await a cross
  451. reference name even after printing the list, so if you don't actually
  452. want to follow a reference, you should type a `Control-g' to cancel the
  453. `f'.
  454.  
  455.    >> Type "f?" to get a list of the cross references in this node.
  456. Then    type a `Control-g' and see how the `f' gives up.
  457.  
  458.    >> Now type `n' to see the last node of the course.
  459.  
  460. 
  461. File: info.info,  Node: Help-Cross,  Up: Help-Adv
  462.  
  463. The node reached by the cross reference in Info
  464. -----------------------------------------------
  465.  
  466.    This is the node reached by the cross reference named `Cross'.
  467.  
  468.    While this node is specifically intended to be reached by a cross
  469. reference, most cross references lead to nodes that "belong" someplace
  470. else far away in the structure of Info.  So you cannot expect the
  471. footnote to have a `Next', `Previous' or `Up' pointing back to where
  472. you came from.  In general, the `l' (el) command is the only way to get
  473. back there.
  474.  
  475.    >> Type `l' to return to the node where the cross reference was.
  476.  
  477. 
  478. File: info.info,  Node: Help-Q,  Prev: Help-Adv,  Up: Getting Started
  479.  
  480. Quitting Info
  481. =============
  482.  
  483.    To get out of Info, back to what you were doing before, type `q' for
  484. "Quit".
  485.  
  486.    This is the end of the course on using Info.  There are some other
  487. commands that are meant for experienced users; they are useful, and you
  488. can find them by looking in the directory node for documentation on
  489. Info.  Finding them will be a good exercise in using Info in the usual
  490. manner.
  491.  
  492.    >> Type `d' to go to the Info directory node; then type    `mInfo'
  493. and Return, to get to the node about Info and    see what other help is
  494. available.
  495.  
  496. 
  497. File: info.info,  Node: Advanced Info,  Next: Creating an Info File,  Prev: Getting Started,  Up: Top
  498.  
  499. Info for Experts
  500. ****************
  501.  
  502.    This chapter describes various advanced Info commands, and how to
  503. write an Info as distinct from a Texinfo file.  (However, in most
  504. cases, writing a Texinfo file is better, since you can use it _both_ to
  505. generate an Info file and to make a printed manual.  *Note Overview of
  506. Texinfo: (texinfo)Top.)
  507.  
  508. * Menu:
  509.  
  510. * Expert::               Advanced Info commands: g, s, e, and 1 - 5.
  511. * Add::                  Describes how to add new nodes to the hierarchy.
  512.                            Also tells what nodes look like.
  513. * Menus::                How to add to or create menus in Info nodes.
  514. * Cross-refs::           How to add cross-references to Info nodes.
  515. * Tags::                 How to make tag tables for Info files.
  516. * Checking::             Checking an Info File
  517. * Emacs Info Variables:: Variables modifying the behavior of Emacs Info.
  518.  
  519. 
  520. File: info.info,  Node: Expert,  Next: Add,  Up: Advanced Info
  521.  
  522. Advanced Info Commands
  523. ======================
  524.  
  525.    `g', `s', `1', - `9', and `e'
  526.  
  527.    If you know a node's name, you can go there by typing `g', the name,
  528. and <RET>.  Thus, `gTop<RET>' would go to the node called `Top' in this
  529. file (its directory node).  `gExpert<RET>' would come back here.
  530.  
  531.    Unlike `m', `g' does not allow the use of abbreviations.
  532.  
  533.    To go to a node in another file, you can include the filename in the
  534. node name by putting it at the front, in parentheses.  Thus,
  535. `g(dir)Top<RET>' would go to the Info Directory node, which is node
  536. `Top' in the file `dir'.
  537.  
  538.    The node name `*' specifies the whole file.  So you can look at all
  539. of the current file by typing `g*<RET>' or all of any other file with
  540. `g(FILENAME)<RET>'.
  541.  
  542.    The `s' command allows you to search a whole file for a string.  It
  543. switches to the next node if and when that is necessary.  You type `s'
  544. followed by the string to search for, terminated by <RET>.  To search
  545. for the same string again, just `s' followed by <RET> will do.  The
  546. file's nodes are scanned in the order they are in in the file, which
  547. has no necessary relationship to the order that they may be in in the
  548. tree structure of menus and `next' pointers.  But normally the two
  549. orders are not very different.  In any case, you can always do a `b' to
  550. find out what node you have reached, if the header is not visible (this
  551. can happen, because `s' puts your cursor at the occurrence of the
  552. string, not at the beginning of the node).
  553.  
  554.    If you grudge the system each character of type-in it requires, you
  555. might like to use the commands `1', `2', `3', `4', ...  `9'.  They are
  556. short for the `m' command together with an argument.  `1' goes through
  557. the first item in the current node's menu; `2' goes through the second
  558. item, etc.
  559.  
  560.    If your display supports multiple fonts, and you are using Emacs'
  561. Info mode to read Info files, the `*' for the fifth menu item is
  562. underlined, and so is the `*' for the ninth item; these underlines make
  563. it easy to see at a glance which number to use for an item.
  564.  
  565.    On ordinary terminals, you won't have underlining.  If you need to
  566. actually count items, it is better to use `m' instead, and specify the
  567. name.
  568.  
  569.    The Info command `e' changes from Info mode to an ordinary Emacs
  570. editing mode, so that you can edit the text of the current node.  Type
  571. `C-c C-c' to switch back to Info.  The `e' command is allowed only if
  572. the variable `Info-enable-edit' is non-`nil'.
  573.  
  574. 
  575. File: info.info,  Node: Add,  Next: Menus,  Prev: Expert,  Up: Advanced Info
  576.  
  577. Adding a new node to Info
  578. =========================
  579.  
  580.    To add a new topic to the list in the Info directory, you must:
  581.   1. Create some nodes, in some file, to document that topic.
  582.  
  583.   2. Put that topic in the menu in the directory.  *Note Menu: Menus.
  584.  
  585.    Usually, the way to create the nodes is with Texinfo (*note Overview
  586. of Texinfo: (texinfo)Top.); this has the advantage that you can also
  587. make a printed manual from them.  However, if you want to edit an Info
  588. file, here is how.
  589.  
  590.    The new node can live in an existing documentation file, or in a new
  591. one.  It must have a <^_> character before it (invisible to the user;
  592. this node has one but you cannot see it), and it ends with either a
  593. <^_>, a <^L>, or the end of file.  Note: If you put in a <^L> to end a
  594. new node, be sure that there is a <^_> after it to start the next one,
  595. since <^L> cannot _start_ a node.  Also, a nicer way to make a node
  596. boundary be a page boundary as well is to put a <^L> _right after_ the
  597. <^_>.
  598.  
  599.    The <^_> starting a node must be followed by a newline or a <^L>
  600. newline, after which comes the node's header line.  The header line
  601. must give the node's name (by which Info finds it), and state the names
  602. of the `Next', `Previous', and `Up' nodes (if there are any).  As you
  603. can see, this node's `Up' node is the node `Top', which points at all
  604. the documentation for Info.  The `Next' node is `Menus'.
  605.  
  606.    The keywords "Node", "Previous", "Up", and "Next", may appear in any
  607. order, anywhere in the header line, but the recommended order is the
  608. one in this sentence.  Each keyword must be followed by a colon, spaces
  609. and tabs, and then the appropriate name.  The name may be terminated
  610. with a tab, a comma, or a newline.  A space does not end it; node names
  611. may contain spaces.  The case of letters in the names is insignificant.
  612.  
  613.    A node name has two forms.  A node in the current file is named by
  614. what appears after the `Node: ' in that node's first line.  For
  615. example, this node's name is `Add'.  A node in another file is named by
  616. `(FILENAME)NODE-WITHIN-FILE', as in `(info)Add' for this node.  If the
  617. file name starts with "./", then it is relative to the current
  618. directory; otherwise, it is relative starting from the standard Info
  619. file directory of your site.  The name `(FILENAME)Top' can be
  620. abbreviated to just `(FILENAME)'.  By convention, the name `Top' is
  621. used for the "highest" node in any single file--the node whose `Up'
  622. points out of the file.  The Directory node is `(dir)'.  The `Top' node
  623. of a document file listed in the Directory should have an `Up: (dir)'
  624. in it.
  625.  
  626.    The node name `*' is special: it refers to the entire file.  Thus,
  627. `g*' shows you the whole current file.  The use of the node `*' is to
  628. make it possible to make old-fashioned, unstructured files into nodes
  629. of the tree.
  630.  
  631.    The `Node:' name, in which a node states its own name, must not
  632. contain a filename, since Info when searching for a node does not expect
  633. one to be there.  The `Next', `Previous' and `Up' names may contain
  634. them.  In this node, since the `Up' node is in the same file, it was
  635. not necessary to use one.
  636.  
  637.    Note that the nodes in this file have a file name in the header
  638. line.  The file names are ignored by Info, but they serve as comments
  639. to help identify the node for the user.
  640.  
  641. 
  642. File: info.info,  Node: Menus,  Next: Cross-refs,  Prev: Add,  Up: Advanced Info
  643.  
  644. How to Create Menus
  645. ===================
  646.  
  647.    Any node in the Info hierarchy may have a "menu"--a list of subnodes.
  648. The `m' command searches the current node's menu for the topic which it
  649. reads from the terminal.
  650.  
  651.    A menu begins with a line starting with `* Menu:'.  The rest of the
  652. line is a comment.  After the starting line, every line that begins
  653. with a `* ' lists a single topic.  The name of the topic-the argument
  654. that the user must give to the `m' command to select this topic--comes
  655. right after the star and space, and is followed by a colon, spaces and
  656. tabs, and the name of the node which discusses that topic.  The node
  657. name, like node names following `Next', `Previous' and `Up', may be
  658. terminated with a tab, comma, or newline; it may also be terminated
  659. with a period.
  660.  
  661.    If the node name and topic name are the same, then rather than
  662. giving the name twice, the abbreviation `* NAME::' may be used (and
  663. should be used, whenever possible, as it reduces the visual clutter in
  664. the menu).
  665.  
  666.    It is considerate to choose the topic names so that they differ from
  667. each other very near the beginning--this allows the user to type short
  668. abbreviations.  In a long menu, it is a good idea to capitalize the
  669. beginning of each item name which is the minimum acceptable
  670. abbreviation for it (a long menu is more than 5 or so entries).
  671.  
  672.    The nodes listed in a node's menu are called its "subnodes", and it
  673. is their "superior".  They should each have an `Up:' pointing at the
  674. superior.  It is often useful to arrange all or most of the subnodes in
  675. a sequence of `Next' and `Previous' pointers so that someone who wants
  676. to see them all need not keep revisiting the Menu.
  677.  
  678.    The Info Directory is simply the menu of the node `(dir)Top'--that
  679. is, node `Top' in file `.../info/dir'.  You can put new entries in that
  680. menu just like any other menu.  The Info Directory is _not_ the same as
  681. the file directory called `info'.  It happens that many of Info's files
  682. live on that file directory, but they do not have to; and files on that
  683. directory are not automatically listed in the Info Directory node.
  684.  
  685.    Also, although the Info node graph is claimed to be a "hierarchy",
  686. in fact it can be _any_ directed graph.  Shared structures and pointer
  687. cycles are perfectly possible, and can be used if they are appropriate
  688. to the meaning to be expressed.  There is no need for all the nodes in
  689. a file to form a connected structure.  In fact, this file has two
  690. connected components.  You are in one of them, which is under the node
  691. `Top'; the other contains the node `Help' which the `h' command goes
  692. to.  In fact, since there is no garbage collector, nothing terrible
  693. happens if a substructure is not pointed to, but such a substructure is
  694. rather useless since nobody can ever find out that it exists.
  695.  
  696. 
  697. File: info.info,  Node: Cross-refs,  Next: Tags,  Prev: Menus,  Up: Advanced Info
  698.  
  699. Creating Cross References
  700. =========================
  701.  
  702.    A cross reference can be placed anywhere in the text, unlike a menu
  703. item which must go at the front of a line.  A cross reference looks
  704. like a menu item except that it has `*note' instead of `*'.  It
  705. _cannot_ be terminated by a `)', because `)''s are so often part of
  706. node names.  If you wish to enclose a cross reference in parentheses,
  707. terminate it with a period first.  Here are two examples of cross
  708. references pointers:
  709.  
  710.      *Note details: commands.  (See *note 3: Full Proof.)
  711.  
  712.    They are just examples.  The places they "lead to" do not really
  713. exist!
  714.  
  715. 
  716. File: info.info,  Node: Tags,  Next: Checking,  Prev: Cross-refs,  Up: Advanced Info
  717.  
  718. Tag Tables for Info Files
  719. =========================
  720.  
  721.    You can speed up the access to nodes of a large Info file by giving
  722. it a tag table.  Unlike the tag table for a program, the tag table for
  723. an Info file lives inside the file itself and is used automatically
  724. whenever Info reads in the file.
  725.  
  726.    To make a tag table, go to a node in the file using Emacs Info mode
  727. and type `M-x Info-tagify'.  Then you must use `C-x C-s' to save the
  728. file.
  729.  
  730.    Once the Info file has a tag table, you must make certain it is up
  731. to date.  If, as a result of deletion of text, any node moves back more
  732. than a thousand characters in the file from the position recorded in
  733. the tag table, Info will no longer be able to find that node.  To
  734. update the tag table, use the `Info-tagify' command again.
  735.  
  736.    An Info file tag table appears at the end of the file and looks like
  737. this:
  738.  
  739.      ^_
  740.      Tag Table:
  741.      File: info, Node: Cross-refs^?21419
  742.      File: info,  Node: Tags^?22145
  743.      ^_
  744.      End Tag Table
  745.  
  746. Note that it contains one line per node, and this line contains the
  747. beginning of the node's header (ending just after the node name), a
  748. Delete character, and the character position in the file of the
  749. beginning of the node.
  750.  
  751. 
  752. File: info.info,  Node: Checking,  Next: Emacs Info Variables,  Prev: Tags,  Up: Advanced Info
  753.  
  754. Checking an Info File
  755. =====================
  756.  
  757.    When creating an Info file, it is easy to forget the name of a node
  758. when you are making a pointer to it from another node.  If you put in
  759. the wrong name for a node, this is not detected until someone tries to
  760. go through the pointer using Info.  Verification of the Info file is an
  761. automatic process which checks all pointers to nodes and reports any
  762. pointers which are invalid.  Every `Next', `Previous', and `Up' is
  763. checked, as is every menu item and every cross reference.  In addition,
  764. any `Next' which does not have a `Previous' pointing back is reported.
  765. Only pointers within the file are checked, because checking pointers to
  766. other files would be terribly slow.  But those are usually few.
  767.  
  768.    To check an Info file, do `M-x Info-validate' while looking at any
  769. node of the file with Emacs Info mode.
  770.  
  771. 
  772. File: info.info,  Node: Emacs Info Variables,  Prev: Checking,  Up: Advanced Info
  773.  
  774. Emacs Info-mode Variables
  775. =========================
  776.  
  777.    The following variables may modify the behaviour of Info-mode in
  778. Emacs; you may wish to set one or several of these variables
  779. interactively, or in your `~/.emacs' init file.  *Note Examining and
  780. Setting Variables: (emacs)Examining.
  781.  
  782. `Info-enable-edit'
  783.      Set to `nil', disables the `e' (`Info-edit') command.  A non-`nil'
  784.      value enables it.  *Note Edit: Add.
  785.  
  786. `Info-enable-active-nodes'
  787.      When set to a non-`nil' value, allows Info to execute Lisp code
  788.      associated with nodes.  The Lisp code is executed when the node is
  789.      selected.
  790.  
  791. `Info-directory-list'
  792.      The list of directories to search for Info files.  Each element is
  793.      a string (directory name) or `nil' (try default directory).
  794.  
  795. `Info-directory'
  796.      The standard directory for Info documentation files.  Only used
  797.      when the function `Info-directory' is called.
  798.  
  799. 
  800. File: info.info,  Node: Creating an Info File,  Prev: Advanced Info,  Up: Top
  801.  
  802. Creating an Info File
  803. *********************
  804.  
  805.    *Note Overview of Texinfo: (texinfo)Top, to learn how to write a
  806. Texinfo file.
  807.  
  808.    *Note Creating an Info File: (texinfo)Creating an Info File, to
  809. learn how to create an Info file from a Texinfo file.
  810.  
  811.    *Note Installing an Info File: (texinfo)Installing an Info File, to
  812. learn how to install an Info file after you have created one.
  813.  
  814.  
  815. 
  816. Tag Table:
  817. Node: Top1059
  818. Node: Getting Started1557
  819. Node: Help-Small-Screen2305
  820. Node: Help4054
  821. Node: Help-P5084
  822. Node: Help-^L5946
  823. Node: Help-M8824
  824. Node: Help-FOO14802
  825. Node: Help-Adv15540
  826. Node: Help-Cross18215
  827. Node: Help-Q18861
  828. Node: Advanced Info19488
  829. Node: Expert20466
  830. Node: Add22980
  831. Node: Menus26340
  832. Node: Cross-refs29214
  833. Node: Tags29916
  834. Node: Checking31218
  835. Node: Emacs Info Variables32171
  836. Node: Creating an Info File33160
  837. 
  838. End Tag Table
  839.